Skip to main content

My Job Recruitment API Documentation

Endpoints​

GET /jobs/job_id/candidates​

Retrieves a list of candidates for a specific job.

URL Parameters​

  • job_id (required): The unique identifier of the job.

Response Format​

  • 200 OK: Successful retrieval of candidates.
    • Response Body: 
      [
        {
          "candidate_id": "string",
          "name": "string",
          "email": "string",
          "applied_date": "date",
          "status": "string",
          // Additional candidate details
        },
        // ... more candidates
      ]

Example Request​

GET /jobs/{`12345`}/candidates

Example Response​

[
  {
    "candidate_id": "cand123",
    "name": "Jane Doe",
    "email": "jane.doe@example.com",
    "applied_date": "2022-01-01",
    "status": "review"
  },
  // ... more candidates
]

DynamoDB Table Design​

For storing job and candidate information in DynamoDB, let's design a table structure. Assume a table named JobCandidates.

DynamoDB Table Structure​

  • Table Name: JobCandidates
  • Primary Key: job_id (Partition Key)
  • Sort Key: candidate_id

Attributes​

  • job_id: String (Unique ID for each job)
  • candidate_id: String (Unique ID for each candidate)
  • name: String
  • email: String
  • applied_date: Date
  • status: String (e.g., "applied", "review", "interview")

Mermaid Diagram for API Overview​

Here's a Mermaid diagram to visually represent the API flow: